home *** CD-ROM | disk | FTP | other *** search
/ United Public Domain Gold 4 / United Public Domain Gold 4.iso / fredfish / ff.0761.dms / ff.0761.adf / AztecErr / AztecErr.doc < prev    next >
Text File  |  1992-11-21  |  9KB  |  268 lines
  1.  
  2.  
  3.                                Documentation
  4.  
  5.                      AztecErr Version 1.0 © 1992 by H.P.G
  6.  
  7.                                    FreeWare
  8.  
  9. Index:
  10.  
  11.         Index
  12.         General Description
  13.         System Reqirements
  14.         Legal Stuff
  15.         Installation
  16.         Commandline
  17.         Using AztecErr
  18.         Arexx-Commands
  19.         Technical
  20.         BUGS
  21.         Last
  22.         Address
  23.  
  24.  
  25. General Description:
  26.  
  27.  
  28.     AztecErr is a programmer-tool.
  29.     It supports the quickfix-option of the Manx Aztec C Compiler Version
  30.     5.xx. It has a full GadTools-User-Interface.
  31.  
  32.     AztecErr is a OS 2.xx only tool. It doesn`t run under Kickstart 1.3.
  33.  
  34.     AztecErr [AE] reads the AztecC.Err file and displayes  the  included
  35.     errors on its window.
  36.     On this window there are several Gadgets. By pressing the Gadgets you
  37.     can simply go to the next, previous, first and last error.
  38.     Alternatively you can press a key instead.
  39.  
  40.     AztecErr has full ENV-support. It sets up two vars with the line and
  41.     column number of the current displayed error. You can read this vars
  42.     and ie  call your editor to jump to the given position.  see  below.
  43.  
  44.     If you have RexxHost.Library, AE opens an  AREXX-Port.  So  you  can
  45.     send a Rexx-Messages to AE with  the same meaning than the  Gadgets.
  46.  
  47.  
  48. System Requirements:
  49.  
  50.     You need at minimum  Kickstart  2.xx.  Version  36L  may  have  some
  51.     problems too, because some functions are  not  implemented  in  this
  52.     version.
  53.  
  54.     AztecErr is most useful if you have installed  the   AztecC   System
  55.     Version 5.xx.
  56.  
  57.     To use AE automatically you should set the  ENV-varible  CCEDIT  via
  58.     MSet (support program of Manx) to AztecErr. Also  you  must  compile
  59.     with  option -qf for QuickFix.
  60.  
  61.     if you want to use AE in another  way,  you  can  use  a  batchfile.
  62.  
  63.     No Requirements but recommentements:
  64.     ===========================================
  65.     If you are using an editor which  has  an  AREXX-Ports  or  supports
  66.     AREXX  or the best, your editor have also the  ability   of   Macro-
  67.     definitions  (f.e.  DMe,  Ced,  TTX  etc...),  so  you  can  use  AE
  68.     automatically.
  69.     E.g.
  70.     If you create a  REXX-Script,  which  examines  the  ENV  variables.
  71.     'AztecErrLastLine' and 'AztevErrLastColumn', you can  directly  jump
  72.     to  the place in your text where the error occured.
  73.     If you call this script after compiling, you can easily  check   all
  74.     errors and compile it again after correcting the last error.
  75.  
  76.     An example Script for DMe is included.
  77.  
  78.     Warning: You  can  use  this  abilities  of  AE  only  if  you  have
  79.              the RexxHost.Library and loads it in memory, like explained
  80.              above.
  81.  
  82.  
  83. Legal Stuff:
  84.  
  85.  
  86.         This  program  and  all files come with it, also the docfiles, are
  87.         released as FREEWARE.
  88.  
  89.         this means:
  90.  
  91.             everybody may use AztecErr,
  92.  
  93.             everybody may copy AztecErr, if:
  94.  
  95.                 1. You copy all included files, see list at the end of the
  96.                    doc file.
  97.                 2. No changes are made,  this  means  the  program and all
  98.                    included files must stay in the original form.
  99.                    Exception: you  may  archieve  it; but in this case you
  100.                               must also archieve the whole package.
  101.                 3. If  you  recompile  it, you have to include a notice to
  102.                    the original author. If you also want to (re)distribute
  103.                    in any new form you have to send me a copy.
  104.                 4. You may not sell AztecErr.
  105.                    Execption: you`re  allowed  to  take  a  small copy fee
  106.                               which should not extend 5US$.
  107.                 5. If you want to include AztecErr
  108.                    or one of the  included files as a part of a commercial
  109.                    package,  you  must  have  written  permission  of  the
  110.                    author (address see below).
  111.  
  112.  
  113.         I take no warranty or garanty for the function of this program.
  114.         The whole risk of using AztecErr stays only by the user.
  115.  
  116.  
  117. Installation:
  118.  
  119.     The best is to copy AztecErr in the same directory in which are  cc,
  120.     as and ln located.
  121.     But it must be in the currently AmigaDOS-searchpath
  122.  
  123. Commandline:
  124.  
  125.     AE supports currently only three commandline parameters which are both
  126.     optional:
  127.  
  128.     TopEdge/N   This is the TopEdge where the window should appear.
  129.                 Default is 0.
  130.  
  131.     PortName=P  This is the Name of the AREXX-Port AE will open.
  132.                 Default is AZTEC_ERROR_PORT.
  133.  
  134.     Screen=S/K  If you want AztecErr  to  appear  on  another  than  the
  135.                 WBenchscreen you can here specify the  name  of  another
  136.                 PublicScreen. Notice: The name is casedependent.
  137.  
  138. Using:
  139.  
  140.     AE supports the  quickfix-option  of  the  Manx  Aztec  C  Compilers
  141.     Version 5.xx. By compiling if an error occures cc calls the  program
  142.     which is the content of the ENV-varable CCEDIT.
  143.     If you set CCEDIT to  AztecErr  [options]  ,  so  AztecErr  will  be
  144.     startet.  AztecErr  reads  the  file  'AztecC.Err'  of  the  current
  145.     directory and opens a window.
  146.     If you quits AztecErr, the compiler starts again.
  147.     If you quits AztecErr by using the Break  Gadget  ,  AztecErr  exits
  148.     with return code 5 (WARN), which can  be  used  in  batch  files  or
  149.     scripts etc.
  150.  
  151.     In the secondline appears a lot  of  Gadgets  displaying  the  first
  152.     error in the AztecC.Err file.
  153.  
  154.     Gadget-List From left to right:
  155.  
  156.     Below Err:          This is the currently displayed error.
  157.     Below Sum:          This is the amount of errors.
  158.     Below Kind:         This is the Kind or the error, either ERROR or
  159.                         WARNING
  160.     Below SourceFile:   This is the name of the SourceFile in which the
  161.                         errors are occured.
  162.     Ln:                 The line number of the error.
  163.     Col:                The column number of the error.
  164.     EC:                 The code of the error.
  165.  
  166.     Below               This is the reason of the error
  167.  
  168.     Next Line:
  169.  
  170.     First         [f]   Activating this Gadget or pressing 'f' AE displays
  171.                         the first error.
  172.     Previous      [p]   AE displayes the previous error.
  173.     Next          [n]   AE displayes the next available error. If there is
  174.                         no more error the following text will be displayed
  175.                         ----- No More Errors ------.
  176.                         Activating next again, closes the window and end
  177.                         the program.
  178.     Last          [l]   AE displays the last error.
  179.     Quit          [q]   AE quits.
  180.     Break         [b]   AE quits with return code 5 (WARN).
  181.  
  182.     You can type also the Keys:
  183.  
  184.     [i]                 Is the same than to click the ZoomGadget of  the
  185.                         window. AE iconifies.
  186.                         WARNING: all functions are  still  availbale  in
  187.                         this state By typing 'i' again the window appears
  188.                         on the old place with the old size.
  189.  
  190. Arexx-Commands:
  191.  
  192.     This commands are aquivalents of the Gadgets above.
  193.  
  194.     FIRST
  195.     PREVIOUS
  196.     NEXT
  197.     LAST
  198.     BREAK
  199.  
  200.     QUIT
  201.     CANCEL        CANCEL is a synonym for QUIT and is only supported for
  202.     EXIT          compatibility with other rexx commands and libraries.
  203.  
  204.  
  205. Technical:
  206.  
  207.     AE uses mainly OS 2.xx functions.
  208.     AE uses DOS-,Intuition- and GadTools.Library
  209.  
  210.     AE because of its size there are no extra error- and  break-handling
  211.     routines included.
  212.     So its yours to take  care  that  AE  don`t  try  to  read  a  wrong
  213.     AztecC.Err file with the wrong format. If this happens AE can crash.
  214.     Also you should not try to end AE whith a ^C, because there is no ^C
  215.     support. Maybe the window  stays  still  open  and  the  program  is
  216.     terminated.
  217.  
  218.     If don`t you have RexxHost.Library , so AE is full functionalbe,  of
  219.     course with the restriction that there is no AREXX-Port  of  AE  and
  220.     the ENV-variables AztecErrLastLine and AztecErrLastColumn  will  not
  221.     be set.
  222.  
  223.     You can call AE also with the command  'rxsend'  of  the  Csh-Shell.
  224.     You doesn`t need an editor which owns an AREXX-Port, its also ok  to
  225.     have an editor which is able to start DOS-commands ( MEmacs etc.  ).
  226.     But its a little more tricky.
  227.  
  228. Last:
  229.  
  230.     I hope many people will use AE to program faster and easier and with
  231.     a less amount of errors.
  232.  
  233.     If you find any bug of AE, please let me know.
  234.  
  235.  
  236.     have fun ..
  237.  
  238.  
  239. Address:
  240.  
  241.    Hans-Peter Guenther
  242.    Gruener Weg 5
  243.    D-3501 Fuldatal 2
  244.    B.R.D (Germnany)
  245.  
  246. List Of Files:
  247.  
  248. (If you miss one of the following files you release is incomplete)
  249.  
  250.     AztecErr                    : The binary
  251.     AztecErr.info
  252.     AztecErr.doc                : English manual
  253.     AztecErr.doc.info
  254.     AztecErr.dok                : German manual
  255.     AztecErr.dok.info
  256.     AztecC.Err                  : Example error file
  257.  
  258.     rexx  (dir)                 : Rexx scripts
  259.         DME_AztecError.dme      : Script for use with DMe
  260.         DME_AztecError.dme.info
  261.         TTX_AztecError.ttx      : Script for use with TTX
  262.         TTX_AztecError.ttx.info
  263.     rexx.info
  264.  
  265.  
  266. ----END
  267.  
  268.